Azure Maps Data Registry Service (preview:2022-12-01)

2025/10/06 • 6 deleted methods

DataRegistry_List (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The `List` request returns an array containing all data registries previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace). This API won't check whether Azure Maps can access the underlying content and whether integrity check is passed for each data registry. Please use [Get Content](https://docs.microsoft.com/rest/api/maps/data-registry/get-content) for the latest status individually. The data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts. >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details. ## Submit List Request To list all your data registries, issue a `GET` request with no additional parameters. ## List Response The `List` request returns an array of data registries in `JSON` format in the body of the response.
Reference :  Link ¶

⚼ Request

GET:  /dataRegistries
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: The version number of Azure Maps API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of data registries. ,
Required: False ,
}
[
{
udid:
{
Description: The user data ID for the data registry. ,
Required: False ,
}
string ,
description:
{
Description: The description given to the data registry. The max length is 1024 characters. ,
Required: False ,
}
string ,
kind:
{
Description: Data registry kind. ,
Enum:
{
AzureBlob: Azure Blob ,
}
,
Required: False ,
}
enum ,
azureBlob:
{
Description: Azure blob data registry details. ,
Required: False ,
}
{
dataFormat:
{
Description: The data format of the uploaded content used for validation purposes. ,
Enum:
{
geojson: [GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format. ,
zip: Compressed data format. ,
}
,
Required: True ,
}
enum ,
msiClientId:
{
Description: Client ID of user-assigned managed identity. Use system-assigned managed identity if not provided. ,
Required: False ,
}
string ,
linkedResource:
{
Description: The ID of the datastore in the Azure Maps account. ,
Required: True ,
}
string ,
blobUrl:
{
Description: The blob URL contains the path to the file being registered. ,
Required: True ,
}
string ,
downloadURL:
{
Description: The `get content` URL used to get the contents of the specified file. It may not be available if the status of the data registry is `Running` or `Failed`. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: The size of the content in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
contentMD5:
{
Description: The content MD5 of the content, used for data validation. ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of a long-running operation. ,
Enum:
{
Running: The request is currently processing. ,
Failed: The request has one or more failures. ,
Completed: The request completed successfully. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of data registries. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DataRegistry_GetDataRegistry (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The `Get Data Registry` request returns the data registry information, as an [AzureBlob](#azureblob) object in JSON format, in the body of the response along with the HTTP status code of 200 when successful. If Azure Maps cannot access the underlying content or the integrity check fails, the `status` is set to `Failed` and and error is returned. The data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts. >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details. ## Submit Get Data Registry Request A data registry `GET` request returns details of the requested data registry, as determined by the specified `udid`. The details are returned in the body of the response in JSON format.
Reference :  Link ¶

⚼ Request

GET:  /dataRegistries/{udid}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: The version number of Azure Maps API. ,
Required: True ,
}
string ,
udid:
{
Description: The user data ID of the data registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
udid:
{
Description: The user data ID for the data registry. ,
Required: False ,
}
string ,
description:
{
Description: The description given to the data registry. The max length is 1024 characters. ,
Required: False ,
}
string ,
kind:
{
Description: Data registry kind. ,
Enum:
{
AzureBlob: Azure Blob ,
}
,
Required: False ,
}
enum ,
azureBlob:
{
Description: Azure blob data registry details. ,
Required: False ,
}
{
dataFormat:
{
Description: The data format of the uploaded content used for validation purposes. ,
Enum:
{
geojson: [GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format. ,
zip: Compressed data format. ,
}
,
Required: True ,
}
enum ,
msiClientId:
{
Description: Client ID of user-assigned managed identity. Use system-assigned managed identity if not provided. ,
Required: False ,
}
string ,
linkedResource:
{
Description: The ID of the datastore in the Azure Maps account. ,
Required: True ,
}
string ,
blobUrl:
{
Description: The blob URL contains the path to the file being registered. ,
Required: True ,
}
string ,
downloadURL:
{
Description: The `get content` URL used to get the contents of the specified file. It may not be available if the status of the data registry is `Running` or `Failed`. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: The size of the content in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
contentMD5:
{
Description: The content MD5 of the content, used for data validation. ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of a long-running operation. ,
Enum:
{
Running: The request is currently processing. ,
Failed: The request has one or more failures. ,
Completed: The request completed successfully. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DataRegistry_RegisterOrReplace (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The `Register` request is used to register data in an Azure Storage Account with an Azure Maps account. The maximum file size that can be registered is one gigabyte. This is useful in scenarios like registering a collection of Geofences in `GeoJSON` format for use in [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or registering a set of DWG design files as a zipped [Drawing Package](https://docs.microsoft.com/azure/azure-maps/drawing-requirements) for use in the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion). The data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts. >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details. ## Submit Register or Replace Request The `Register` and `Replace` requests are both long-running operations that contain an [AzureBlob](#azureblob) JSON object in the body of the request that defines the data registry details.
Reference :  Link ¶

⚼ Request

PUT:  /dataRegistries/{udid}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: The version number of Azure Maps API. ,
Required: True ,
}
string ,
udid:
{
Description: The user data ID of the data registry. ,
Required: True ,
}
string ,
Operation-Id:
{
Description: The operation ID, in GUID format. ,
Required: False ,
}
string ,
dataRegistry:
{
Description: The data to be registered. ,
Required: True ,
}
{
udid:
{
Description: The user data ID for the data registry. ,
Required: False ,
}
string ,
description:
{
Description: The description given to the data registry. The max length is 1024 characters. ,
Required: False ,
}
string ,
kind:
{
Description: Data registry kind. ,
Enum:
{
AzureBlob: Azure Blob ,
}
,
Required: False ,
}
enum ,
azureBlob:
{
Description: Azure blob data registry details. ,
Required: False ,
}
{
dataFormat:
{
Description: The data format of the uploaded content used for validation purposes. ,
Enum:
{
geojson: [GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format. ,
zip: Compressed data format. ,
}
,
Required: True ,
}
enum ,
msiClientId:
{
Description: Client ID of user-assigned managed identity. Use system-assigned managed identity if not provided. ,
Required: False ,
}
string ,
linkedResource:
{
Description: The ID of the datastore in the Azure Maps account. ,
Required: True ,
}
string ,
blobUrl:
{
Description: The blob URL contains the path to the file being registered. ,
Required: True ,
}
string ,
downloadURL:
{
Description: The `get content` URL used to get the contents of the specified file. It may not be available if the status of the data registry is `Running` or `Failed`. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: The size of the content in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
contentMD5:
{
Description: The content MD5 of the content, used for data validation. ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of a long-running operation. ,
Enum:
{
Running: The request is currently processing. ,
Failed: The request has one or more failures. ,
Completed: The request completed successfully. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-id:
{
Description: ID of the status monitor for the operation. ,
}
string ,
operation-location:
{
Description: A URL used to check the status or results of the request when it is a long-running operation. `api-version` is not included in the URL. ,
}
string ,
}
,
$schema:
{
Description: The data registry in Azure Maps. ,
}
{
udid:
{
Description: The user data ID for the data registry. ,
Required: False ,
}
string ,
description:
{
Description: The description given to the data registry. The max length is 1024 characters. ,
Required: False ,
}
string ,
kind:
{
Description: Data registry kind. ,
Enum:
{
AzureBlob: Azure Blob ,
}
,
Required: False ,
}
enum ,
azureBlob:
{
Description: Azure blob data registry details. ,
Required: False ,
}
{
dataFormat:
{
Description: The data format of the uploaded content used for validation purposes. ,
Enum:
{
geojson: [GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format. ,
zip: Compressed data format. ,
}
,
Required: True ,
}
enum ,
msiClientId:
{
Description: Client ID of user-assigned managed identity. Use system-assigned managed identity if not provided. ,
Required: False ,
}
string ,
linkedResource:
{
Description: The ID of the datastore in the Azure Maps account. ,
Required: True ,
}
string ,
blobUrl:
{
Description: The blob URL contains the path to the file being registered. ,
Required: True ,
}
string ,
downloadURL:
{
Description: The `get content` URL used to get the contents of the specified file. It may not be available if the status of the data registry is `Running` or `Failed`. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: The size of the content in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
contentMD5:
{
Description: The content MD5 of the content, used for data validation. ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of a long-running operation. ,
Enum:
{
Running: The request is currently processing. ,
Failed: The request has one or more failures. ,
Completed: The request completed successfully. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-id:
{
Description: ID of the status monitor for the operation. ,
}
string ,
operation-location:
{
Description: New URL to check for the results of the long-running operation. `api-version` is not included in the URL. ,
}
string ,
}
,
$schema:
{
Description: The data registry in Azure Maps. ,
}
{
udid:
{
Description: The user data ID for the data registry. ,
Required: False ,
}
string ,
description:
{
Description: The description given to the data registry. The max length is 1024 characters. ,
Required: False ,
}
string ,
kind:
{
Description: Data registry kind. ,
Enum:
{
AzureBlob: Azure Blob ,
}
,
Required: False ,
}
enum ,
azureBlob:
{
Description: Azure blob data registry details. ,
Required: False ,
}
{
dataFormat:
{
Description: The data format of the uploaded content used for validation purposes. ,
Enum:
{
geojson: [GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format. ,
zip: Compressed data format. ,
}
,
Required: True ,
}
enum ,
msiClientId:
{
Description: Client ID of user-assigned managed identity. Use system-assigned managed identity if not provided. ,
Required: False ,
}
string ,
linkedResource:
{
Description: The ID of the datastore in the Azure Maps account. ,
Required: True ,
}
string ,
blobUrl:
{
Description: The blob URL contains the path to the file being registered. ,
Required: True ,
}
string ,
downloadURL:
{
Description: The `get content` URL used to get the contents of the specified file. It may not be available if the status of the data registry is `Running` or `Failed`. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: The size of the content in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
contentMD5:
{
Description: The content MD5 of the content, used for data validation. ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of a long-running operation. ,
Enum:
{
Running: The request is currently processing. ,
Failed: The request has one or more failures. ,
Completed: The request completed successfully. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DataRegistry_Unregister (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The `Unregister` request removes a data registry without deleting the underlying content frm the Azure storage account. Useful in scenarios like unregistering geofence files previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace) for use in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or unregistering a compressed (ZIP) file containing DWG design files used by the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion). The data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts. >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details. ## Submit Unregister Request Use an HTTP `DELETE` request with the `udid` of the data registry to unregister. ## Unregister Response The `Unregister` request returns a HTTP '204 No Content' response with an empty body, if the data registry was deleted successfully.
Reference :  Link ¶

⚼ Request

DELETE:  /dataRegistries/{udid}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: The version number of Azure Maps API. ,
Required: True ,
}
string ,
udid:
{
Description: The user data ID of the data registry. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DataRegistry_GetContent (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The `Get Content` request returns the contents of the specified file in the body of the response. The content is not available if the status is `Running` or `Failed`. The data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts. >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details. ## Submit Get Content Request To get the contents of a registered file, include the user data ID (`udid`) in a `dataRegistries` request. ## Get Content Response The `Get Content` request returns the contents of the file in the response body, along with the HTTP status code of 200 when successful. The HTTP status code 400 (Bad Request) is returned if the file registry process failed or is still running.
Reference :  Link ¶

⚼ Request

GET:  /dataRegistries/{udid}/content
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: The version number of Azure Maps API. ,
Required: True ,
}
string ,
udid:
{
Description: The user data ID of the data registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: The Content-Type of the the specified `udid`. ,
}
string ,
}
,
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DataRegistry_GetOperation (removed)
Description :  The HTTP `GET` request used to get the status of a [data register or replace](/rest/api/maps/data-registry/register-or-replace) request is returned in the header of the register or replace response as the value of the `Operation-Location` key. While in progress, a HTTP `200 OK` response will be returned with `Retry-After` header - followed by a HTTP `200 OK` with no extra header once completed. The data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts. >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.
Reference :  Link ¶

⚼ Request

GET:  /dataRegistries/operations/{operationId}
{
api-version:
{
Description: The version number of Azure Maps API. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID used to query the status of a data register request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: Recommended minimum number of seconds to wait before next check. ,
}
integer ,
}
,
$schema:
{
Description: The response model for a long-running operation. ,
}
{
id:
{
Description: The operationId ,
Required: False ,
}
string ,
status:
{
Description: The status of a long-running operation. ,
Enum:
{
Running: The request is currently processing. ,
Failed: The request has one or more failures. ,
Completed: The request completed successfully. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}